Skip to content

Conversation

@FeudalDiana
Copy link
Contributor

Changes

Updated names to match official Roblox Lua Styling guide for consistency.
Apologies for the multiple commits due to web editor.

https://roblox.github.io/lua-style-guide/#naming

Checks

By submitting your pull request for review, you agree to the following:

  • This contribution was created in whole or in part by me, and I have the right to submit it under the terms of this repository's open source licenses.
  • I understand and agree that this contribution and a record of it are public, maintained indefinitely, and may be redistributed under the terms of this repository's open source licenses.
  • To the best of my knowledge, all proposed changes are accurate.

@FeudalDiana FeudalDiana requested a review from a team as a code owner January 6, 2025 20:59
@github-actions github-actions bot added the engine guides Changes the Engine guides label Jan 6, 2025
@IgnisRBX
Copy link
Contributor

IgnisRBX commented Jan 13, 2025

Thanks for the pull request! I just reverted playerId to playerID since "ID" as an abbreviation for "identification" reads a bit better IMO than "Id" (and yes, I admit there is inconsistency across the site for this, with some APIs including "...Id...", but let's stick with "ID". :) )

@IgnisRBX IgnisRBX merged commit d5b0881 into Roblox:main Jan 13, 2025
3 checks passed
@Bottersnike
Copy link

Bottersnike commented Jan 13, 2025

@IgnisRBX The style guide suggests

For acronyms within names, don't capitalize the whole thing. For example, aJsonVariable or MakeHttpCall.

The exception to this is when the abbreviation represents a set. For example, in anRGBValue or GetXYZ. In these cases, RGB should be treated as an abbreviation of RedGreenBlue and not as an acronym.

Id would be a contraction of Identification (or similar) which doesn't qualify for the only listed exception. Further, Id is used rather than ID across Roblox APIs (eg GetStudioUserId) so it stands that this convention should be followed in all places?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

engine guides Changes the Engine guides

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants